Std PythonHelp/ru

Автоматически сгенерированная документация python

Расположение в меню
Справка → Автоматически сгенерированная документация python
Верстаки
Все
Быстрые клавиши
Нет
Представлено в версии
-
См. также
Документация по созданию скриптов на Python

Описание

Команда Автоматически сгенерированная документация Python запускает веб-сервер, который связывается с браузером по умолчанию через локальный сокет. Веб-сервер отображает информацию о доступных модулях, классах и функциях FreeCAD на языке Python. Необходимые страницы генерируются автоматически.

Веб-сервер основан на модуле Python module-pydoc pydoc и, таким образом, извлекает строковые описания файлов Python (*.py), а также текстовую документацию, определённую в оболочках Python (*.xml), которые раскрывают базовый код C++.

Применение

  1. Выбери в меню Справка → Автоматически сгенерированная документация Python.
  2. Щёлкни любую из ссылок, чтобы перейти к документации по конкретному классу или функции.